Skip to content

Remove support for sx from Checkbox component #6654

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Remove support for sx from Checkbox component #6654

wants to merge 6 commits into from

Conversation

llastflowers
Copy link
Contributor

@llastflowers llastflowers commented Aug 22, 2025 •
edited
Loading

Closes https://github.com/github/primer/issues/5759

Current sx usage: 2

✅ sx usages are only in repos other than github-ui; those usages have been added to the tracking issue

Changelog

Removed

Remove support for sx from the Checkbox component, and associated stories, docs, and tests

Rollout strategy

  • Major release; if selected, include a written rollout or migration plan

We are using the @primer/styled-react component to mitigate removing sx usage. We will make sure usage is updated upstream before merging.

Merge checklist

@llastflowers llastflowers self-assigned this Aug 22, 2025
@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Aug 22, 2025 •
edited
Loading

🦋 Changeset detected

Latest commit: 2900240

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages
Name Type
@primer/react Major
@primer/styled-react Major

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions GitHub Actions
Copy link
Contributor

👋 Hi, this pull request contains changes to the source code that github/github depends on. If you are GitHub staff, we recommend testing these changes with github/github using the integration workflow. Thanks!

@github-actions github-actions bot added the integration-tests: recommended This change needs to be tested for breaking changes. See https://arc.net/l/quote/tdmpakpm label Aug 22, 2025
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Aug 22, 2025 •
edited
Loading

size-limit report 📦

Path Size
packages/react/dist/browser.esm.js 87.97 KB (+0.04% 🔺)
packages/react/dist/browser.umd.js 88.02 KB (-0.17% 🔽)

@github-actions github-actions bot requested a deployment to storybook-preview-6654 August 22, 2025 21:44 Abandoned
@github-actions github-actions bot temporarily deployed to storybook-preview-6654 August 22, 2025 21:52 Inactive
@llastflowers llastflowers marked this pull request as ready for review September 4, 2025 22:53
@Copilot Copilot AI review requested due to automatic review settings September 4, 2025 22:53
@llastflowers llastflowers requested a review from a team as a code owner September 4, 2025 22:53
Copilot
Copilot AI reviewed Sep 4, 2025
View reviewed changes
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR removes the deprecated sx prop support from the Checkbox component as part of Primer React's migration away from styled-system. The change removes the sx prop from the component interface, eliminates the conditional rendering logic that wrapped the checkbox in a Box component when sx was present, and updates associated documentation and tests.

Key Changes:

  • Removed sx prop from CheckboxProps interface and component implementation
  • Simplified component rendering by removing conditional Box wrapper logic
  • Updated Storybook configuration and documentation to reflect the removed prop

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
packages/react/src/Checkbox/Checkbox.tsx Removed SxProp type, Box import, sx parameter, and conditional rendering logic
packages/react/src/Checkbox/Checkbox.stories.tsx Removed sx from excluded control keys in Storybook configuration
packages/react/src/Checkbox/Checkbox.docs.json Removed sx prop documentation entry
.changeset/tasty-cheetahs-pay.md Added changeset documenting the breaking change

@github-actions github-actions bot temporarily deployed to storybook-preview-6654 September 4, 2025 23:03 Inactive
@francinelucca
Copy link
Member

Note: make sure to run integration checks 🙏

@github-actions github-actions bot added integration-tests: failing Changes in this PR cause breaking changes in gh/gh and removed integration-tests: recommended This change needs to be tested for breaking changes. See https://arc.net/l/quote/tdmpakpm labels Sep 5, 2025
@primer-integration
Copy link

👋 Hi from github/github-ui! Your integration PR is ready: https://github.com/github/github-ui/pull/1928

@llastflowers llastflowers removed the integration-tests: failing Changes in this PR cause breaking changes in gh/gh label Sep 5, 2025
@github-actions github-actions bot added the integration-tests: failing Changes in this PR cause breaking changes in gh/gh label Sep 5, 2025
@primer-integration
Copy link

🟢 ci completed with status success.

@github-actions github-actions bot added integration-tests: passing Changes in this PR do NOT cause breaking changes in gh/gh and removed integration-tests: failing Changes in this PR cause breaking changes in gh/gh labels Sep 8, 2025
@llastflowers llastflowers added this pull request to the merge queue Sep 8, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Sep 8, 2025
@llastflowers llastflowers added this pull request to the merge queue Sep 8, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Sep 8, 2025
@llastflowers llastflowers removed the request for review from TylerJDev September 10, 2025 18:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

Copilot code review Copilot Copilot left review comments

@francinelucca francinelucca francinelucca approved these changes

Assignees

@llastflowers llastflowers

Labels
integration-tests: passing Changes in this PR do NOT cause breaking changes in gh/gh
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@llastflowers @francinelucca